/*
 * Copyright 2012 Faculty of Informatics - Masaryk University.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package cz.muni.fi.pa165.creatures.dao;

import cz.muni.fi.pa165.creatures.model.Creature;
import cz.muni.fi.pa165.creatures.model.CreatureType;
import cz.muni.fi.pa165.creatures.model.Region;
import java.util.List;

/**
 * This interface represents a contract for implementation of the DAO for the
 * {@link cz.muni.fi.pa165.creatures.model.Creature} entity.
 *
 * @author xmiklos1
 */
public interface CreatureDAO {

    /**
     * This method creates a creature.
     *
     * @param creature creature to create
     * @return id of the created creature
     */
    Long create(Creature creature);

    /**
     * This method removes a creature.
     *
     * @param creature creature to remove
     */
    void remove(Creature creature);

    /**
     * This method updates already existing creature.
     *
     * @param creature creature to update
     */
    void update(Creature creature);

    /**
     * This method gets a creature of some {@code id}.
     *
     * @param id id of the creature we want to get
     * @return creature of specified {@code id}, null otherwise
     */
    Creature get(Long id);

    /**
     * This method returns count of creatures in our simple world.
     *
     * @return number of the all creatures
     */
    Long getCount();

    /**
     * This method returns all creatures in our simple world.
     *
     * @return a list of all creatures, if there are no creatures, the returned
     * list is an empty list, not null
     */
    List<Creature> getAll();

    /**
     * This method returns all creatures which live in a specified
     * {@code region}.
     *
     * @param region region to get all creatures from
     * @return list of all creatures which live in a specified {@code region}
     */
    List<Creature> getCreaturesOf(Region region);

    /**
     * This method returns all creatures of specified
     * {@link cz.muni.fi.pa165.creatures.model.CreatureType}.
     *
     * @param creatureType creature type we want to get creatures of
     * @return list of creatures of specified {@code creatureType}
     */
    List<Creature> getCreaturesOf(CreatureType creatureType);

    /**
     * This method returns the count of creatures of some creature type.
     *
     * @param creatureTypeEntity creature type we want to know number of
     * creatures of
     * @return the count of creatures of some creature type
     */
    Long getCountOf(CreatureType creatureTypeEntity);

    /**
     * This method gets creature by it's name.
     *
     * @param name name of a creature to get
     * @return creature of specified {@code name}.
     */
    Creature getByName(String name);

    /**
     * Deletes all creatures.
     */
    void deleteAll();
}
